/**
 * Copyright (C) 2013 DaiKit.com - daikit4gxt module (admin@daikit.com)
 *
 *         Project home : http://code.daikit.com/daikit4gxt
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.daikit.daikit4gxt.client.editor;

import com.google.gwt.editor.client.Editor;
import com.google.gwt.editor.client.SimpleBeanEditorDriver;


/**
 * Interface for {@link DkBeanEditorDriver}
 * 
 * @author tcaselli
 * @version $Revision$ Last modifier: $Author$ Last commit: $Date$
 * @param <T>
 *           the bean type
 * @param <E>
 *           the editor type for T
 */
public interface DkSimpleBeanEditorDriver<T, E extends Editor<T>> extends SimpleBeanEditorDriver<T, E>
{

	/**
	 * Wrapper to {@link #flush(boolean,boolean)} with flushEvenIfValidationFails=false and validateHiddenFields=false
	 */
	@Override
	T flush();

	/**
	 * @param flushEvenIfValidationFails
	 *           Wrapper to {@link #flush(boolean,boolean)} with validateHiddenFields=false
	 * @return the flushed bean
	 */
	T flush(final boolean flushEvenIfValidationFails);

	/**
	 * 
	 * Update the object being edited with the current state of the Editor.<br>
	 * <br>
	 * First apply validation and retrieve error messages (accessible through {@link #getErrors()}) <br>
	 * Then if (validation failed and flushEvenIfValidationFails=false) or (validation succeeded)<br>
	 * -> Flush editor fields into bean attributes.
	 * 
	 * @param flushEvenIfValidationFails
	 * @param validateHiddenFields
	 *           boolean indicating whether to valdiate hidden fields or not
	 * @return the flushed object (=the object passed into {@link #edit(Object)}) or null if validation failed and
	 *         flushEvenIfValidationFails is false
	 * @throws IllegalStateException
	 *            if {@link #edit(Object)} has not been called
	 */
	T flush(final boolean flushEvenIfValidationFails, final boolean validateHiddenFields);

}
